Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docs about logs #2432

Merged
merged 12 commits into from
Nov 27, 2024
Merged

Add docs about logs #2432

merged 12 commits into from
Nov 27, 2024

Conversation

jBorkowska
Copy link
Collaborator

No description provided.

Copy link

docs-page bot commented Nov 25, 2024

To view this pull requests documentation preview, visit the following URL:

docs.page/leancodepl/patrol~2432

Documentation is deployed and generated using docs.page.

@github-actions github-actions bot added the docs Concerns doc comments, READMEs, or docs label Nov 25, 2024
docs/logs.mdx Outdated
Comment on lines 15 to 16
If you're using this version but you don't see any logs, check if you have your own `PatrolTesterConfig` passed
to `patrolTest()`. If yes, add `printLogs: true` argument to this constructor.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

don't see any logs

If user don't see any logs, than it will be another problem. This flag steer only showing test steps from patrol_finders actions. E.g. native action steps still will be printed.

docs/logs.mdx Outdated
Comment on lines 82 to 84
- --[no-]show-flutter-logs -> Show Flutter logs while running the tests. (Available only in `patrol test`)
- --[no-]hide-test-steps -> Hide test steps while running the tests.
- --[no-]clear-test-steps -> Clear test steps after the test finishes.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It will be useful to add here default values (for clear-test-steps it's true).
Maybe this should be a table with columns:

  • flag
  • default value
  • available in test/develop
  • description

@jBorkowska jBorkowska marked this pull request as ready for review November 26, 2024 10:57
docs/logs-announcement.mdx Show resolved Hide resolved
docs/logs-announcement.mdx Show resolved Hide resolved
@mateuszwojtczak mateuszwojtczak self-requested a review November 27, 2024 10:19
Copy link
Contributor

@mateuszwojtczak mateuszwojtczak left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@mateuszwojtczak mateuszwojtczak merged commit bdf05ae into master Nov 27, 2024
8 of 11 checks passed
@mateuszwojtczak mateuszwojtczak deleted the docs/rich-test-output branch November 27, 2024 10:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Concerns doc comments, READMEs, or docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants